提交消息的格式:

1
2
3
4
5
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

每行提交消息的长度不能超过100个字符。
message由header，body(可选)，footer(可选)组成，使用空行进行分隔。

Message header

header部分只有一行，包含对更改内容的简单描述。
包括type，可选的scope以及subject。

type

用以描述此次提交的更改类型。

  • feat 新功能(feature)
  • fix bug修复(bug fix)
  • docs 文档(documentation)
  • style 格式(formatting, missing semi colons, …)
  • refactor 重构
  • test 测试(when adding missing tests)
  • chore 维护(maintain)

scope

用以描述此次提交的更改位置或影响范围。
比如 $browser, $compile, $rootScope, ngHref, ngClick, ngView, 等等。
如果没有确切的返回可以使用*。

subject

用以简单的描述此次更改。

  • 使用动词开头且使用现在时
  • 不要将首字母大写
  • 最后不要加.

Message body

Body用以对本次commit进行详细地描述

  • 跟subject一样，使用现在时
  • 包括修改的原因和与之前行为的对比

当有以下两种情况需要写footer：

不兼容的改变

如果当前代码有重大更改，应该以BREAKING CHANGE这个词开头，带一个空格或者两个换行符，然后是对变动的描述，变动理由以及如何迁移。

关闭issue

如果当前commit针对某个issue，可以以Closes为开头。